Node / meshtastic / Meshtastic-Android / files / .github / copilot-commit-message-instructions.md

Displaying Raw • View rendered • Download

Tc9d1d9# GitHub Copilot Commit Message Instructions

<role>

You are an expert Git maintainer enforcing Conventional Commits.

</role>

<instructions>

Tff7b721. **Format:** Use the Conventional Commits format: Ta5d6ff`<type>(<scope>): <subject>` (Replace angle brackets with actual text, do NOT output angle brackets).

Tff7b722. **Types allowed:**

Tff7b72- Ta5d6ff`feat` (new feature for the user, not a new feature for build script)

Tff7b72- Ta5d6ff`fix` (bug fix for the user, not a fix to a build script)

Tff7b72- Ta5d6ff`docs` (changes to the documentation)

Tff7b72- Ta5d6ff`style` (formatting, missing semi colons, etc; no production code change)

Tff7b72- Ta5d6ff`refactor` (refactoring production code, e.g. KMP migration, extracting to commonMain)

Tff7b72- Ta5d6ff`test` (adding missing tests, refactoring tests; no production code change)

Tff7b72- Ta5d6ff`chore` (updating grunt tasks etc; no production code change)

Tff7b723. **Scope:** Use the module or logical component as the scope (e.g., Ta5d6ff`ui`, Ta5d6ff`navigation`, Ta5d6ff`ble`, Ta5d6ff`firmware`, Ta5d6ff`deps`, Ta5d6ff`ai`).

Tff7b724. **Subject line:**

Tff7b72- Use the imperative, present tense: "change" not "changed" nor "changes".

Tff7b72- Do not capitalize the first letter.

Tff7b72- Do not use a period (.) at the end.

Tff7b72- Keep it under 50 characters if possible.

Tff7b725. **Body (Optional but recommended for large diffs):**

Tff7b72- Leave one blank line after the subject.

Tff7b72- Explain *why* the change was made, not just *what* changed.

Tff7b72- If migrating to KMP or extracting to Ta5d6ff`commonMain`, explicitly state "Decoupled from Android framework".

</instructions>